Adds proper documentation for rsa_encrypt and rsa_decrypt. #598
Conversation
Superhepper
requested review from
Firstyear,
hug-dev,
ionut-arm and
wiktor-k
Superhepper
force-pushed
the
Doc-Asymmetric-Primitives
branch
from
addf239 to
1c30489
Compare
ionut-arm
left a comment
ionut-arm
left a comment
There was a problem hiding this comment.
Looks good, thanks, couple of minor tweaks ⬇️
Superhepper
force-pushed
the
Doc-Asymmetric-Primitives
branch
2 times, most recently
from
391eb90 to
44e9562
Compare
wiktor-k
left a comment
wiktor-k
left a comment
There was a problem hiding this comment.
I think it looks good but I've left a couple of small nitpicks 😅
tss-esapi/src/lib.rs
Outdated
| //! # Code examples | ||
| //! The code examples are just small snippets of all the different steps that are necessary | ||
| //! in order to get the examples to actually work so it is recommended to check all the steps | ||
| //! in comments in the source code, or in the documented examples in our repo. |
There was a problem hiding this comment.
Hmm... I don't really know what this comment is trying to say, that the code examples are just rudimentary? Or that the commented-out sections may also be important? 🤔
There was a problem hiding this comment.
It is trying to say that the code examples in documentation are usually only showing a small part of all the necessary steps needed in order to make things actually work.
And that thing shown is mostly focused around context method call or other points of interest,
There was a problem hiding this comment.
It is trying to say that the code examples in documentation are usually only showing a small part of all the necessary steps needed in order to make things actually work.
And that thing shown is mostly focused around context method call or other points of interest,
There was a problem hiding this comment.
I will try to rephrase it to make that point clear.
Superhepper
force-pushed
the
Doc-Asymmetric-Primitives
branch
from
44e9562 to
c0a158f
Compare
Signed-off-by: Jesper Brynolf <jesper.brynolf@gmail.com>
Superhepper
force-pushed
the
Doc-Asymmetric-Primitives
branch
from
c0a158f to
feafd12
Compare
| /// * `cipher_text` - The cipher text to be decrypted. | ||
| /// * `in_scheme` - The padding scheme to use if scheme associated with | ||
| /// the `key_handle` is [RsaDecryptionScheme::Null]. | ||
| /// * `label` - A label whose association with the message is to be verified. |
There was a problem hiding this comment.
Does the label have to match the label used during encrypt?
There was a problem hiding this comment.
TCG TPM 2.0 Specification, Revision 01.59, Part 3 - Commands, Section 14.3 - TPM2_RSA_Decrypt
If a label is used in the padding process of the scheme during encryption, the label parameter is required
to be present in the decryption process and label is required to be the same in both cases. If label is not
the same, the decrypt operation is very likely to fail ((TPM_RC_VALUE). If label is present (label.size !=
0), it shall be a byte stream whose last byte is zero or the TPM will return TPM_RC_VALUE.
NOTE 1 The size of label includes the terminating null.
I also noticed another thing that the label is optional. So I will have to adress that as well.
4 participants
No description provided.